chore: add watcher for cy-prompt development #31810
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Adds support for a live-reload watcher in the CyPrompt flow when developing against a local cy-prompt path.
- Refactors
ensureCyPromptBundleto always compute its ownbundlePathand remove the old local-copy branch - Introduces a
chokidarwatcher inCyPromptLifecycleManagerguarded byCYPRESS_LOCAL_CY_PROMPT_PATH - Updates unit tests to cover both remote bundle and local watcher scenarios
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/server/test/unit/cloud/cy-prompt/ensure_cy_prompt_bundle_spec.ts | Removed local‐path stubs/tests; adjusted copy/readFile stubs |
| packages/server/test/unit/cloud/cy-prompt/CyPromptLifecycleManager_spec.ts | Added tests for watcher setup and listener behavior in local mode |
| packages/server/lib/cloud/cy-prompt/ensure_cy_prompt_bundle.ts | Dropped local-copy logic; derive bundlePath via path.join |
| packages/server/lib/cloud/cy-prompt/CyPromptLifecycleManager.ts | Added hashLoadingMap, integrated chokidar watcher, extracted cloud metadata |
| packages/server/lib/cloud/StudioLifecycleManager.ts (deleted) | Removed outdated Studio lifecycle manager |
Comments suppressed due to low confidence (3)
packages/server/lib/cloud/cy-prompt/CyPromptLifecycleManager.ts:19
- [nitpick] The name
hashLoadingMapis ambiguous; consider renaming it tohashLoadingPromisesorloadingPromiseByHashfor clearer intent.
private static hashLoadingMap: Map<string, Promise<void>> = new Map()
packages/server/test/unit/cloud/cy-prompt/CyPromptLifecycleManager_spec.ts:100
- Consider adding a test that calls
initializeCyPromptManagermultiple times with the same cyPromptHash to verify thatensureCyPromptBundleis only invoked once and that subsequent calls reuse the cached promise.
// Add tests for cached bundle loading behavior
packages/server/lib/cloud/cy-prompt/ensure_cy_prompt_bundle.ts:14
- The code uses
path.joinbut thepathmodule is not imported. Addimport path from 'path'at the top of the file to avoid a ReferenceError.
const bundlePath = path.join(cyPromptPath, 'bundle.tar')
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
ryanm/chore/add-watch-for-cy-prompt
|
| Run status |
|
| Run duration | 18m 23s |
| Commit |
|
| Committer | Ryan Manuel |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
8
|
Pending
|
1232
|
Skipped
|
0
|
Passing
|
32187
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
46.11%
|
|
|---|---|
|
Untested elements
|
189
|
|
Tested elements
|
166
|
Accessibility
92.73%
|
|
|---|---|
|
Failed rules
|
3 critical
9 serious
2 moderate
2 minor
|
|
Failed elements
|
698
|
mschile
approved these changes
Jun 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional details
Add watcher for cy-prompt development that is enabled when
process.env.CYPRESS_LOCAL_CY_PROMPT_PATHis set. This goes along with this PR.Steps to test
How has the user experience changed?
PR Tasks
cypress-documentation?type definitions?